This web method allows to create an activity for an existing service user in the system. ServiceUserId, AddressId and other fields will be required in order to raise an activity. TypeId (15) will allow users to create a delivery request for an EIN. TypeId (16) will allow users to create a collection request for an EIN. "ActivityTypeGet" web method returns all available Activity Types. Similarly, Activity Response Time can also be determined from "ResponseTimesGet" Web Method in order to raise an activity with appropriate speed code. Please note that response times are setup by activity type in the system.
Description
Request (CreateNewActivityForExistingServiceUserSoapIn)
The request body is of type CreateNewActivityForExistingServiceUser.
Request Body Parameters
| Name | Description | Data Type |
|---|---|---|
| objProviderGUId | This is a unique provider id, which can be obtained from CSS GUId | guid |
| strPassword | This is your unique service password which can be obtained from CSS String (min 1 max 50) | xml:string |
| intProviderBranchId | This is the providers branch making the web service call (can be obtained via the ProviderBranchesGet web method) Integer | xml:int |
| intServiceUserId | This field is a primary key for a service user. ServiceUserId can be determined from "ManifestingServiceUserSearch" web method. This field will be used to create an acitity for a service user in the system. Integer | xml:int |
| intAddressId | This is an address field to allow users to place an activity for a paticular address. "ManifestingServiceUserSearch" web method will return "DefaultAddressUId" for a service user which can be used to place an activity in the system. Please note that service user can have more than one addresses where a delivery or collection order can be requested from. Integer | xml:int |
| intTypeId | This is an activity type field to raise a hire delivery request for a service user. e.g TypeId 15 - hire Delivery and TypeId 16 - Collection | xml:int |
| strActivityNotes | This field contains any paticular activity notes user wants to add while raisng a hire request. Notes will be visible when viewing this activity. String (min 1 max 400) | xml:string |
| strUniqueStockRefs | This is an EIN/Unique Stock Reference you want to hire. Please note that you can raise an activity for multiple EINS/Unique Stock References with ";" seperation. You can find EINS/Unique Stock References by using other web methods within Pro-Cloud API. Please note that a valid Unique Stock Reference is required to create an activity. The following EINS are already used for testing purposes. e.g. 113-35;113-34;113-36;113-37; String (min 1 to varchar(max)) | xml:string |
| intResponseId | This is a response time field which generates a target date for an activity. "ResponseTimesGet" Web Method returns all available response times ids with descriptions within a contract. Please use "ResponseTimesGet" Web Service to fnd acorrect ResponseId. e.g. 4179 - Courier Delivery Integer | xml:int |
Overview
 |
|
Response (CreateNewActivityForExistingServiceUserSoapOut)
The response body is of type CreateNewActivityForExistingServiceUserResponse.
Response Body Parameters
| Name | Description | Data Type |
|---|---|---|
| CreateNewActivityForExistingServiceUserResult | objCreateNewActivityForExistingServiceUserReturn |
Overview
|
|
Example
<?xml version="1.0" encoding="utf-8"?> <objCreateNewActivityForExistingServiceUserReturn xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://pro-cloud.org/"> <intErrorId>0</intErrorId> <strErrorMsg /> <xmlDataSet> <NewDataSet xmlns=""> <CreateNewActivityForExistingServiceUser> <ActivityId>344999</ActivityId> <ActivityGUId>D175F2E6-D1FE-49DA-BD26-F4B9017E3F7D</ActivityGUId> <ServiceUserId>154299</ServiceUserId> <ServiceUserGUId>CCB4C57B-31DE-4F6D-B723-50CCB0948293</ServiceUserGUId> </CreateNewActivityForExistingServiceUser> </NewDataSet> </xmlDataSet> </objCreateNewActivityForExistingServiceUserReturn>
See Also